home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Nordlicht Spiele / Nordlicht Spiele 11-05 (19xx)(Nordlicht)(DE)(PD).zip / Nordlicht Spiele 11-05 (19xx)(Nordlicht)(DE)(PD).adf / ArmyMiner / ArmyMiner.doc / ArmyMiner.doc
Text File  |  1992-09-23  |  10KB  |  251 lines
  1.  
  2.  
  3.                                  ARMYMINER v1.2
  4.  
  5.                                   May 30, 1993
  6.  
  7.  
  8. Preface
  9. ~~~~~~~
  10.  
  11.      This program is freeware, binary only. You are free to use it as
  12. long as you leave my copyright notice intact. You can distribute this program
  13. as long as you don't ask any more money for it than a nominal fee for copying,
  14. and if you keep this document with it. If you want to include this program in
  15. a commercial package you need my written permission.
  16.  
  17.              "Copyright 1993 Alain Laferriere, All rights reserved"
  18.  
  19.      If you have suggestions or remarks about this program, or if you find
  20. any bugs, please let me know.
  21.  
  22.      You can reach me at the following address:
  23.  
  24.                              Alain Laferriere
  25.                              5190 Drolet #1
  26.                              Montreal, Quebec, H2T 2H2
  27.                              Canada
  28.  
  29.                              Telephone: (514) 277-6668
  30.  
  31.      If you have access to Internet, you'll be able to reach me anytime at
  32.      the following address:
  33.  
  34.                       E-mail: laferrie@iro.umontreal.ca
  35.  
  36.      Since I read my mail everyday, you can expect a fast answer.
  37.  
  38.  
  39. Contents
  40. ~~~~~~~~
  41.  
  42. 1. Introduction
  43.  
  44. 2. Usage
  45.  
  46. 3. Bugs and history
  47.  
  48. 4. Job hunting
  49.  
  50. 5. Special thanks
  51.  
  52.  
  53. 1. Introduction
  54. ~~~~~~~~~~~~~~~
  55.  
  56.   Of all the Amiga versions of Minesweeper or X-Mines I've seen so far, none
  57. was complete enough to satisfy me. I felt that a program that would integrate
  58. all of the good features I've seen in different programs was needed. Also,
  59. the program architecture itself was offering a really interesting challenge so
  60. I decided to write my own.
  61.  
  62.   Armyminer works under 1.3 and 2.0, either on PAL or NTSC. It requires
  63. no external libraries whatsoever.
  64.  
  65.   Armyminer was developped on Amiga 3000UX, with Manx Aztec C v5.2a, CED and
  66. Enforcer.
  67.  
  68.  
  69. 2. Usage
  70. ~~~~~~~~
  71.  
  72.   Armyminer can be started from the cli or by clicking its icon in the
  73. WorkBench environment. If first verifies if the stack is sufficient to
  74. handle worst case recursivity. If it's not the case then the following
  75. message is diplayed on screen (if run from CLI):
  76.  
  77.     Stack size is 12000 bytes
  78.     Stack must be at least 30000 bytes to run Armyminer
  79.  
  80.   When you start Armyminer from the cli, you can specify an initial seed
  81. value for the pseudo-random number generator. For example:
  82.  
  83.     Armyminer 25643
  84.  
  85.   That feature is really interesting for people who want to compete on the
  86. same boards, by setting the same seed value. Note however that when the
  87. "safe start" switch is enabled, the first clicked square will determine
  88. the board's initial configuation. So, if you want to compete with a friend
  89. you have to either turn that switch off (in which case the board's
  90. configuration will always be the same no matter which square is first
  91. clicked) or to both click on the same square to start the game.
  92. If no seed value is specified, the program calculates a new seed
  93. by using the current system's time.
  94.  
  95.   Armyminer possess 4 different game settings:
  96.  
  97.     BEGINNER MODE : 8 by 8 board, 15% (9) bombs
  98.  
  99.     ADVANCED MODE : 30 by 16 board, 21% (100) bombs
  100.  
  101.     EXPERT MODE   : 25 by 25 board, 24% (150) bombs
  102.  
  103.     CUSTOM MODE   : You select the board width, height and bomb percentage
  104.  
  105.   Armyminer starts in ADVANCED mode. These board settings are similar to
  106. the ones in the X-Window's XMines. You can start playing the game by
  107. clicking on any square, or choose a different setting by either selecting
  108. it in the menus (or by using the keyboard alternates) or by clicking on the
  109. corresponding gadget on screen.
  110.  
  111.   As you will notice, there is a PAUSE option which temporarily hides the
  112. board and pauses the timer. It's a very interesting feature as it lets you
  113. answer the phone (or eat a pizza slice) in the middle of a game, by example.
  114. That PAUSE options is only available when there is a game in progress. When
  115. it's not the case, the gadget is ghosted. When you select the "About" item
  116. when a game is in process, the timer is also paused so you can continue
  117. the game without loosing time. The PAUSE option can be activated by clicking
  118. on the PAUSE gadget, or by pressing the 'p' key on the keyboard.
  119.  
  120.   When the game window in inactivated, the counter temporarily pauses and
  121. restarts when the game is reactivated.
  122.  
  123.   Like in other minesweeper-type games available, you use the mouse in the
  124. following way:
  125.  
  126.   - Use left mouse button to click (push down) a square in the board
  127.   - Use right mouse button to toggle the state of a covered square
  128.   - Use right or left mouse button on an uncovered square to clean its
  129.     neighbours (when the number of marked squares in its neighbourhood is
  130.     the same as the number written on the uncovered square itself).
  131.  
  132.   In the OPTIONS menu, you'll find the following items:
  133.  
  134.   - Use question marks. Lets the user cycle the state of a covered square
  135.     (by clicking the right mouse button when the mouse pointer is over the
  136.     square) from unmarked, to marked (check mark symbol), to a question
  137.     mark ("?") to unmarked. When inactive, the square state is toggled from
  138.     unmarked to marked to unmarked. This option was available on the
  139.     IBM-compatible Minesweeper so I decided it would be nice to have it
  140.     here.
  141.  
  142.   - Safe start. Assures you that the first square you'll click when starting
  143.     a new game will have no bombs in its immediate neighbours. That way, you
  144.     are sure to clean a part of the board. When inactive, you have absolutely
  145.     no garantee to start a game safely and it's possible to explode on the
  146.     first click.
  147.  
  148.   - Auto mark. By clicking the left or right mouse button when the mouse pointer
  149.     is over an uncovered square, forces all its neighbours to be marked as bombs
  150.     when they are in equal number as the number written on the uncovered square
  151.     itself. That option makes the game a lot more easy.
  152.  
  153.   - Safe click. Forces the board squares to be treated as normal Amiga gadgets.
  154.     That means if you push a square and keep the left mouse button pressed,
  155.     then move the mouse, the square will return to its covered state. When this
  156.     option in turned off, moving the mouse will have no effect and the square
  157.     will be pushed anyway. The IBM-compatible Minesweeper reacts as having the
  158.     safe click option ON. Some players (like me) prefer to turn it off because
  159.     when you click squares rapidly (i.e. moving the mouse at the same time),
  160.     the gadget-like behavior will ignore some of the clicked squares and put
  161.     them back to their original covered state.
  162.  
  163.   - Sound effects. There is sound effects for pushing, popping, marking and
  164.     exploding a square, also there is a "good work son" played when your score
  165.     is good enough to enter the high-score table. You can turn them ON or OFF
  166.     with that option.
  167.  
  168.   The default settings of these options for each mode are:
  169.  
  170.       Mode     Use question marks    Safe start    Auto mark    Safe Click
  171.       ----     ------------------    ----------    ---------    ----------
  172.  
  173.     BEGINNER         ACTIVE            ACTIVE        ACTIVE       ACTIVE
  174.     ADVANCED        INACTIVE           ACTIVE       INACTIVE     INACTIVE
  175.      EXPERT         INACTIVE           ACTIVE       INACTIVE     INACTIVE
  176.      CUSTOM         INACTIVE           ACTIVE        ACTIVE      INACTIVE
  177.  
  178.   There are 4 high-scores tables (BEGINNER, ADVANCED, EXPERT, CUSTOM). The first
  179. three of those are ordered by timer values since the board dimensions remain
  180. the same in each. The custom high-score table entries are ordered in a
  181. different way. The "score" is calculated in regard to the board dimensions, the
  182. bomb percentage and the timer value.
  183.  
  184.   The SCORES menu possess the following items:
  185.  
  186.   - SHOW : Displays any of the high-scores table
  187.  
  188.   - CLEAR : Resets all the entries of any of the high-scores table
  189.  
  190.  
  191. 3. Bugs and history
  192. ~~~~~~~~~~~~~~~~~~~
  193.  
  194. v1.2:
  195. ----
  196.  
  197.   ArmyMiner v1.2 is now uncompressed. Many persons prefered speed of
  198. execution when starting the game over the disk space it occupies. This
  199. version also corrects a bug that happened with system fonts different
  200. than "topaz 8". You now can pause the game by pressing the 'p' key on
  201. the keyboard. You unpause the game as usual, by clicking in the pause
  202. window.
  203.  
  204. v1.1:
  205. ----
  206.  
  207.   ArmyMiner v1.0 did not work on the Amiga 4000 due to the fact that the
  208. executable was compressed with the "TNM CRUNCHER v1.1" which crashes on
  209. that machine. ArmyMiner v1.1 is compressed with PowerPacker which is said
  210. to work perfectly on all Amigas.
  211.  
  212. v1.0:
  213. ----
  214.  
  215.   The only problem that remains is the string gadget behavior (when a user
  216. enters his name in the high-score table). Under 2.0, the gadget is
  217. autoactivated but under 1.3, the user must first click in it.
  218.  
  219.   Since I developped that program with Enforcer v37.25, there are no bad
  220. memory access problems for sure!
  221.  
  222.  
  223. 4. Job hunting
  224. ~~~~~~~~~~~~~~
  225.  
  226.   This is my first official release of a program in the Amiga community.
  227. However, I wrote lots of other programs (tools, disk utilities, etc) for
  228. myself and friends and I am getting very comfortable with the Amiga computer.
  229.  
  230.   My next project is not yet decided but I think I'll go for a commercial
  231. shoot-em up development or maybe a really complete text processing tool.
  232. If there are any commercial software development companies listening out
  233. there, you have my address. If you need somebody to code stuff then you
  234. know how to contact me.
  235.  
  236.   I know that lots of european magazines put public domain and freeware
  237. software on their cover disks. If my program happens to appear on such a
  238. disk, I'll be very thankful to receive a copy of the magazine and to hear
  239. from anybody who likes my program and wants to discuss about it.
  240.  
  241.  
  242. 5. Special thanks
  243. ~~~~~~~~~~~~~~~~~
  244.  
  245.   Special thanks goes to my good friend Daniel Beaudry, who made the
  246. "About" menu's picture and other graphics. Also thanks to Pierre Rioux
  247. who did a wonderful job at sending bug reports and suggestions.
  248. Philippe Hebrais, Lucie Jolicoeur, Eric Prevot and Jocelyn Cloutier
  249. also played many games and gave me very good suggestions that were
  250. later included.
  251.